<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>IgH EtherCAT Master: pdo.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">IgH EtherCAT Master
   &#160;<span id="projectnumber">1.5.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('pdo_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">pdo.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="pdo_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/******************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *  $Id: pdo.h,v 2bf892fe8080 2010/02/23 14:49:12 fp $</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> *  Copyright (C) 2006-2008  Florian Pose, Ingenieurgemeinschaft IgH</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> *  This file is part of the IgH EtherCAT Master.</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> *  The IgH EtherCAT Master is free software; you can redistribute it and/or</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> *  modify it under the terms of the GNU General Public License version 2, as</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> *  published by the Free Software Foundation.</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> *  The IgH EtherCAT Master is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> *  but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> *  Public License for more details.</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> *  You should have received a copy of the GNU General Public License along</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> *  with the IgH EtherCAT Master; if not, write to the Free Software</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> *  ---</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"> *  The license mentioned above concerns the source code only. Using the</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"> *  EtherCAT technology and brand is only permitted in compliance with the</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"> *  industrial property and similar rights of Beckhoff Automation GmbH.</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"> *****************************************************************************/</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment">/*****************************************************************************/</span></div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="preprocessor">#ifndef __EC_PDO_H__</span></div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="preprocessor">#define __EC_PDO_H__</span></div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="preprocessor">#include &lt;linux/list.h&gt;</span></div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="globals_8h.html">globals.h</a>&quot;</span></div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="pdo__entry_8h.html">pdo_entry.h</a>&quot;</span></div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment">/*****************************************************************************/</span></div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;</div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structec__pdo__t.html">   49</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>{</div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="structec__pdo__t.html#aa7e6a0e0405c93414052c6d998d604ad">   50</a></span>&#160;    <span class="keyword">struct </span>list_head list; </div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structec__pdo__t.html#ae319ba9b8bed2ac49cf6596ff690cfdd">   51</a></span>&#160;    uint16_t <a class="code" href="structec__pdo__t.html#ae319ba9b8bed2ac49cf6596ff690cfdd">index</a>; </div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structec__pdo__t.html#ade04e761df137353930d271ed34120c9">   52</a></span>&#160;    int8_t <a class="code" href="structec__pdo__t.html#ade04e761df137353930d271ed34120c9">sync_index</a>; </div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structec__pdo__t.html#aee9c14db0de4c72475b8975d5630ad94">   53</a></span>&#160;    <span class="keywordtype">char</span> *<a class="code" href="structec__pdo__t.html#aee9c14db0de4c72475b8975d5630ad94">name</a>; </div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="structec__pdo__t.html#aaac321c4f80081e5f69e2ff30eac80e5">   54</a></span>&#160;    <span class="keyword">struct </span>list_head entries; </div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;} <a class="code" href="structec__pdo__t.html">ec_pdo_t</a>;</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment">/*****************************************************************************/</span></div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="keywordtype">void</span> <a class="code" href="pdo_8h.html#afa7a6b78374dc77781dbf9bae1b3dbca">ec_pdo_init</a>(<a class="code" href="structec__pdo__t.html">ec_pdo_t</a> *);</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="keywordtype">int</span> <a class="code" href="pdo_8h.html#a379f80cf524f77c572bf4e7c1c33e60a">ec_pdo_init_copy</a>(<a class="code" href="structec__pdo__t.html">ec_pdo_t</a> *, <span class="keyword">const</span> <a class="code" href="structec__pdo__t.html">ec_pdo_t</a> *);</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="keywordtype">void</span> <a class="code" href="pdo_8h.html#a51588a6c044259c2db97a2be97eabfd9">ec_pdo_clear</a>(<a class="code" href="structec__pdo__t.html">ec_pdo_t</a> *);</div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="keywordtype">void</span> <a class="code" href="pdo_8h.html#a9264d3cb9d741ea6b72f5a3e9be382e4">ec_pdo_clear_entries</a>(<a class="code" href="structec__pdo__t.html">ec_pdo_t</a> *);</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="keywordtype">int</span> <a class="code" href="pdo_8h.html#a2b1aa61f35283459bf3f08d39ba68697">ec_pdo_set_name</a>(<a class="code" href="structec__pdo__t.html">ec_pdo_t</a> *, <span class="keyword">const</span> <span class="keywordtype">char</span> *);</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<a class="code" href="structec__pdo__entry__t.html">ec_pdo_entry_t</a> *<a class="code" href="pdo_8h.html#afc7d57ceab25f33b80e1a3e02f9b9f59">ec_pdo_add_entry</a>(<a class="code" href="structec__pdo__t.html">ec_pdo_t</a> *, uint16_t, uint8_t, uint8_t);</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="keywordtype">int</span> <a class="code" href="pdo_8h.html#acad614a71cd8ab870ddd6a3b4d7d945c">ec_pdo_copy_entries</a>(<a class="code" href="structec__pdo__t.html">ec_pdo_t</a> *, <span class="keyword">const</span> <a class="code" href="structec__pdo__t.html">ec_pdo_t</a> *);</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="keywordtype">int</span> <a class="code" href="pdo_8h.html#a2f62be7f735f9fc7453f44520fbe0982">ec_pdo_equal_entries</a>(<span class="keyword">const</span> <a class="code" href="structec__pdo__t.html">ec_pdo_t</a> *, <span class="keyword">const</span> <a class="code" href="structec__pdo__t.html">ec_pdo_t</a> *);</div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="pdo_8h.html#a851d9510d8a7442d14b9732ece737490">ec_pdo_entry_count</a>(<span class="keyword">const</span> <a class="code" href="structec__pdo__t.html">ec_pdo_t</a> *);</div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="keyword">const</span> <a class="code" href="structec__pdo__entry__t.html">ec_pdo_entry_t</a> *<a class="code" href="pdo_8h.html#accb4909a2a3434cc64f0eda3dadffef0">ec_pdo_find_entry_by_pos_const</a>(</div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;        <span class="keyword">const</span> <a class="code" href="structec__pdo__t.html">ec_pdo_t</a> *, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>);</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="keywordtype">void</span> <a class="code" href="pdo_8h.html#ada7e926581a6a55fad6714a498297192">ec_pdo_print_entries</a>(<span class="keyword">const</span> <a class="code" href="structec__pdo__t.html">ec_pdo_t</a> *);</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="comment">/*****************************************************************************/</span></div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="pdo_8h_html_afa7a6b78374dc77781dbf9bae1b3dbca"><div class="ttname"><a href="pdo_8h.html#afa7a6b78374dc77781dbf9bae1b3dbca">ec_pdo_init</a></div><div class="ttdeci">void ec_pdo_init(ec_pdo_t *)</div><div class="ttdoc">PDO constructor. </div><div class="ttdef"><b>Definition:</b> <a href="pdo_8c_source.html#l00046">pdo.c:46</a></div></div>
<div class="ttc" id="pdo_8h_html_a2b1aa61f35283459bf3f08d39ba68697"><div class="ttname"><a href="pdo_8h.html#a2b1aa61f35283459bf3f08d39ba68697">ec_pdo_set_name</a></div><div class="ttdeci">int ec_pdo_set_name(ec_pdo_t *, const char *)</div><div class="ttdoc">Set PDO name. </div><div class="ttdef"><b>Definition:</b> <a href="pdo_8c_source.html#l00125">pdo.c:125</a></div></div>
<div class="ttc" id="pdo_8h_html_acad614a71cd8ab870ddd6a3b4d7d945c"><div class="ttname"><a href="pdo_8h.html#acad614a71cd8ab870ddd6a3b4d7d945c">ec_pdo_copy_entries</a></div><div class="ttdeci">int ec_pdo_copy_entries(ec_pdo_t *, const ec_pdo_t *)</div><div class="ttdoc">Copy PDO entries from another PDO. </div><div class="ttdef"><b>Definition:</b> <a href="pdo_8c_source.html#l00186">pdo.c:186</a></div></div>
<div class="ttc" id="globals_8h_html"><div class="ttname"><a href="globals_8h.html">globals.h</a></div><div class="ttdoc">Global definitions and macros. </div></div>
<div class="ttc" id="structec__pdo__entry__t_html"><div class="ttname"><a href="structec__pdo__entry__t.html">ec_pdo_entry_t</a></div><div class="ttdoc">PDO entry description. </div><div class="ttdef"><b>Definition:</b> <a href="pdo__entry_8h_source.html#l00048">pdo_entry.h:48</a></div></div>
<div class="ttc" id="structec__pdo__t_html_ae319ba9b8bed2ac49cf6596ff690cfdd"><div class="ttname"><a href="structec__pdo__t.html#ae319ba9b8bed2ac49cf6596ff690cfdd">ec_pdo_t::index</a></div><div class="ttdeci">uint16_t index</div><div class="ttdoc">PDO index. </div><div class="ttdef"><b>Definition:</b> <a href="pdo_8h_source.html#l00051">pdo.h:51</a></div></div>
<div class="ttc" id="structec__pdo__t_html_ade04e761df137353930d271ed34120c9"><div class="ttname"><a href="structec__pdo__t.html#ade04e761df137353930d271ed34120c9">ec_pdo_t::sync_index</a></div><div class="ttdeci">int8_t sync_index</div><div class="ttdoc">Assigned sync manager. </div><div class="ttdef"><b>Definition:</b> <a href="pdo_8h_source.html#l00052">pdo.h:52</a></div></div>
<div class="ttc" id="pdo_8h_html_a9264d3cb9d741ea6b72f5a3e9be382e4"><div class="ttname"><a href="pdo_8h.html#a9264d3cb9d741ea6b72f5a3e9be382e4">ec_pdo_clear_entries</a></div><div class="ttdeci">void ec_pdo_clear_entries(ec_pdo_t *)</div><div class="ttdoc">Clear PDO entry list. </div><div class="ttdef"><b>Definition:</b> <a href="pdo_8c_source.html#l00106">pdo.c:106</a></div></div>
<div class="ttc" id="structec__pdo__t_html"><div class="ttname"><a href="structec__pdo__t.html">ec_pdo_t</a></div><div class="ttdoc">PDO description. </div><div class="ttdef"><b>Definition:</b> <a href="pdo_8h_source.html#l00049">pdo.h:49</a></div></div>
<div class="ttc" id="pdo_8h_html_a51588a6c044259c2db97a2be97eabfd9"><div class="ttname"><a href="pdo_8h.html#a51588a6c044259c2db97a2be97eabfd9">ec_pdo_clear</a></div><div class="ttdeci">void ec_pdo_clear(ec_pdo_t *)</div><div class="ttdoc">PDO destructor. </div><div class="ttdef"><b>Definition:</b> <a href="pdo_8c_source.html#l00094">pdo.c:94</a></div></div>
<div class="ttc" id="pdo_8h_html_a851d9510d8a7442d14b9732ece737490"><div class="ttname"><a href="pdo_8h.html#a851d9510d8a7442d14b9732ece737490">ec_pdo_entry_count</a></div><div class="ttdeci">unsigned int ec_pdo_entry_count(const ec_pdo_t *)</div><div class="ttdoc">Get the number of PDO entries. </div><div class="ttdef"><b>Definition:</b> <a href="pdo_8c_source.html#l00257">pdo.c:257</a></div></div>
<div class="ttc" id="pdo__entry_8h_html"><div class="ttname"><a href="pdo__entry_8h.html">pdo_entry.h</a></div><div class="ttdoc">EtherCAT Process data object structure. </div></div>
<div class="ttc" id="pdo_8h_html_a2f62be7f735f9fc7453f44520fbe0982"><div class="ttname"><a href="pdo_8h.html#a2f62be7f735f9fc7453f44520fbe0982">ec_pdo_equal_entries</a></div><div class="ttdeci">int ec_pdo_equal_entries(const ec_pdo_t *, const ec_pdo_t *)</div><div class="ttdoc">Compares the entries of two PDOs. </div><div class="ttdef"><b>Definition:</b> <a href="pdo_8c_source.html#l00222">pdo.c:222</a></div></div>
<div class="ttc" id="pdo_8h_html_ada7e926581a6a55fad6714a498297192"><div class="ttname"><a href="pdo_8h.html#ada7e926581a6a55fad6714a498297192">ec_pdo_print_entries</a></div><div class="ttdeci">void ec_pdo_print_entries(const ec_pdo_t *)</div><div class="ttdoc">Outputs the PDOs in the list. </div><div class="ttdef"><b>Definition:</b> <a href="pdo_8c_source.html#l00299">pdo.c:299</a></div></div>
<div class="ttc" id="structec__pdo__t_html_aee9c14db0de4c72475b8975d5630ad94"><div class="ttname"><a href="structec__pdo__t.html#aee9c14db0de4c72475b8975d5630ad94">ec_pdo_t::name</a></div><div class="ttdeci">char * name</div><div class="ttdoc">PDO name. </div><div class="ttdef"><b>Definition:</b> <a href="pdo_8h_source.html#l00053">pdo.h:53</a></div></div>
<div class="ttc" id="pdo_8h_html_a379f80cf524f77c572bf4e7c1c33e60a"><div class="ttname"><a href="pdo_8h.html#a379f80cf524f77c572bf4e7c1c33e60a">ec_pdo_init_copy</a></div><div class="ttdeci">int ec_pdo_init_copy(ec_pdo_t *, const ec_pdo_t *)</div><div class="ttdoc">PDO copy constructor. </div><div class="ttdef"><b>Definition:</b> <a href="pdo_8c_source.html#l00062">pdo.c:62</a></div></div>
<div class="ttc" id="pdo_8h_html_afc7d57ceab25f33b80e1a3e02f9b9f59"><div class="ttname"><a href="pdo_8h.html#afc7d57ceab25f33b80e1a3e02f9b9f59">ec_pdo_add_entry</a></div><div class="ttdeci">ec_pdo_entry_t * ec_pdo_add_entry(ec_pdo_t *, uint16_t, uint8_t, uint8_t)</div><div class="ttdoc">Add a new PDO entry to the configuration. </div><div class="ttdef"><b>Definition:</b> <a href="pdo_8c_source.html#l00157">pdo.c:157</a></div></div>
<div class="ttc" id="pdo_8h_html_accb4909a2a3434cc64f0eda3dadffef0"><div class="ttname"><a href="pdo_8h.html#accb4909a2a3434cc64f0eda3dadffef0">ec_pdo_find_entry_by_pos_const</a></div><div class="ttdeci">const ec_pdo_entry_t * ec_pdo_find_entry_by_pos_const(const ec_pdo_t *, unsigned int)</div><div class="ttdoc">Finds a PDO entry via its position in the list. </div><div class="ttdef"><b>Definition:</b> <a href="pdo_8c_source.html#l00279">pdo.c:279</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_c1346cf4828efdd0d2baf0d391d01b77.html">master</a></li><li class="navelem"><a class="el" href="pdo_8h.html">pdo.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
